home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
ShareWare OnLine 2
/
ShareWare OnLine Volume 2 (CMS Software)(1993).iso
/
bbsdoors
/
qwkrk60.zip
/
QWKRICK.DOC
< prev
next >
Wrap
Text File
|
1993-03-09
|
13KB
|
350 lines
QWKRick Version .70 Beta
March 8, 1993
Created with Searchlight Programmer's Library
Portions Copyright (c) 1992 Searchlight Software
Welcome to the wonderful world of QWK Mail Doors. This program,
named 'QWKRick' will allow your users to Scan and Download new Messages
and Mail from SearchLight Version 3.00 and Higher.
Many hours were spent working on this door and it is not FreeWare!
It has been released as Shareware and as such, the Author expects compensation
for his hard work and time. As this is a Beta Version, a price has not yet
been set, but expect it to be in the $10-20 range. The Author also makes no
warranties, implied or expressed, to the correct funtioning of this door.
Installation
────────────
All QWKRick needs to know is what it is expected to do.
An Example of the Download menu is as follows:
1. Command Name .................. Download
2. Command Key ................... D
3. Description ................... Download a Mail Packet
4. Minimum Access Level .......... 0
5. Maximum Access Level .......... 255
6. Required Attributes ...........
7. Exclude Attributes ............
8. Preference Attributes .........
9. Help Levels ................... All
10. Door Command .................. QWKRick.exe DOWN
11. Directory Path ................ C:\BBS\RICK
12. Communications Support ........ Standard
13. Abort Method .................. Terminate
14. Write Protection .............. No
15. Parameter File ................ None
16. Pause After Door .............. No
Line 10 contains the command to Download new Messages from the BBS,
the only important letter is D, although you may specify all or part of
Download if you want. If running from a batch file then Line 10 would contain
the name of the Batch file and Line 11 the directory in which you've stored
the batch file. The batch would then look something like this:
c:
cd \bbs\rick
Set SLBBS=c:\bbs\node1
QWKRick.exe Down
An Example of the Upload menu is as follows:
1. Command Name .................. Upload
2. Command Key ................... U
3. Description ................... Upload a Mail Packet
4. Minimum Access Level .......... 0
5. Maximum Access Level .......... 255
6. Required Attributes ...........
7. Exclude Attributes ............
8. Preference Attributes .........
9. Help Levels ................... All
10. Door Command .................. QWKRick.exe UP
11. Directory Path ................ C:\BBS\RICK
12. Communications Support ........ Standard
13. Abort Method .................. Terminate
14. Write Protection .............. No
15. Parameter File ................ None
16. Pause After Door .............. No
Line 10 contains the command to Upload new Messages to the BBS,
the only important letter is U, although you may specify all or part of
Upload if you want. If running from a batch file then Line 10 would contain
the name of the Batch file and Line 11 the directory in which you've stored
the batch file. The batch would then look something like this:
c:
cd \bbs\rick
Set SLBBS=c:\bbs\node1
QWKRick.exe Up
Remember that in order to run, the SLBBS environment variable must
be set to your BBS path. An example is:
Set SLBBS=c:\bbs\node1
The above menus are included to make it a little easier to install.
Frank LaRosa has also included a new command in SL 3.00 or greater. Command
number 144. This command will allow the users to edit their QWK Options.
The layout of the menu is as follows:
Options:
1. Transfer Protocol ............. Zmodem
2. Archive Type .................. ZIP
3. Packet Number ................. 32
4. Naming Convention ............. Prefix
5. Generate Indexes .............. Yes
6. DL Messages from You .......... Yes
7. Mark New Messages ............. Yes
8. Packet Type ................... QWK
Line 1 - Xfer Protocol. Xmodem, Ymodem and Zmodem are supported.
Line 2 - Archiver. Currently only ZIP is supported, but others will
be added soon.
Line 3 - Packet Number. The number that will be appended to the name
of the download packet. (IE BBSID32.QWK)
Line 4 - The method in which the Download packet is called.
Prefix will generate BBSID##.QWK packets.
Suffix will generate BBSID.QW# packets.
Some off-line readers, notably BlueWave, prefer the BBSID.QW#
format.
Line 5 - Generate .NDX files per conference. Again, some readers do
not need .NDX files to funtion, thereby saving download time.
Line 6 - Download messages that you entered or Uploaded, if No, then
any messages with the same user name as the current user will
not be selected for download
Line 7 - Mark New Messages will update High Message Pointers if set to
YES, other wise it will leave them alone.
Line 8 - User configurable New Files scan. Until the Options are
changed, QWK stands for Yes and Text Stands for No.
Local Use
─────────
QWKRick may be used locally, just insure that the BBSID.rep packet
is in the same directory as QWKRick. QWKRick will move and unzip it itself,
and delete it when done. Downloads will be placed in the same spot.
Other Neat Stuff
────────────────
Users may add or drop conferences remotely by sending a message to
QWKRick, SEARCHLIGHT or '' (IE no To User) in the conference they wish to
add or drop. The Subject line should then contain the word ADD or DROP.
QWKRick will then ADD or DROP the user from the Message Base in which the
message was uploaded to.
Many offline reader support this directly so the user doesn't have to
worry about it if they Add or Drop the conference via their reader.
The QWKRICK File
──────────────────
An QWKRICK.CFG file must exist in the same directory as QWKRick in
order for QWKRick to operate. A sample file is included, but the layout is
as follows.
St. Laurent, Quebec
(514) 748-5673
Rick Macdougall,Sysop
985,RIGEL
RIGEL
300 Baud,25,50
600 Baud,50,100
1200 Baud,100,200
2400 Baud,200,400
4800 Baud,400,800
7200 Baud,500,1000
9600 Baud,500,1000
12000 Baud,500,1000
14400 Baud,500,1000
16800 Baud,600,1600
19200 Baud,600,1600
38400 Baud,600,1600
Local,1000,5000
Yes ; Error Log
Yes ; User Log
Yes ; Enforce Time Checking
pkzip %F
pkunzip %F
c:\bbs\node1\gsz.exe portx %A,%I sx %F
c:\bbs\node1\gsz.exe portx %A,%I sb -k %F
c:\bbs\node1\gsz.exe portx %A,%I sz %F
c:\bbs\node1\gsz.exe portx %A,%I rx %F
c:\bbs\node1\gsz.exe portx %A,%I rb -k %F
c:\bbs\node1\gsz.exe portx %A,%I rz %F
AAAAAAA
------------------------------------------------------------------
!!! Warning !!!
Changes made above the line affect the running of your SL QWK Door!
Please Read the Following lines before making any changes.
Line 1: Your Location. Free Format Field, you may change it as you like.
Line 2: Your BBS Phone Number. Format should stay as (XXX) XXX-XXX, but it
really shouldn't hurt the working of the Door if it is modified.
Line 3: Sysops Real Name and alias on the board. Again Free Format, but try
to keep it similar.
Line 4: Your SL Registration Number and BBSID. This line is Important! Do
Not add a space after the Comma! And some Readers prefer if it is
capitalized.
Line 5: Your BBSID again. No Spaces, Capitalized etc.. I know it's duped,
but this is just a temp fix until the Sysop Editor is finished.
Lines 6 thru 18:
Baud Rate Lines in the format:
Comment,Max Messages per sub, Max Messages Total
Do not remove any of the lines, but you may change the values to
whatever you like. The first part (Comment) is just that, a Comment,
so you may but whatever you like there, but I highly recommend you
leave them as is so that you remember what baud rate each line is.
Line 19: Error Log Creation. First character only is checked. Yes is on,
No is off.
Line 20: User Log Creation. First Character only is Checked. Yes is on,
No, is off.
Line 21: Enforce Time Checking. First Character Only. If set to Yes, then
QWKRick will check to make sure that enough time remains for the
user to download the packet. If set to No then no time limit
checking is done.
Line 22: Archive Command Line. %F is replaced by the filename and files to
Archive in the format 'Pkzip.exe BBSID.QW# *.*'
^^^^^^^^^^^^^
Line 23: DeArchive Command Line. %F is replaced by the filename to De-
archive in the format 'Pkunzip.exe BBSID.REP'
^^^^^^^^^
Line 24: Xmodem or THIRD protocol SEND option. Command line parameters
will be explained at the end of this section.
Line 25: Ymodem or SECOND protocol SEND option. Command line parameters
will be explained at the end of this section.
Line 26: Zmodem or FIRST protocol SEND option. Command line parameters
will be explained at the end of this section.
Line 27: Xmodem or THIRD protocol RCV option. Command line parameters
will be explained at the end of this section.
Line 28: Ymodem or SECOND protocol RCV option. Command line parameters
will be explained at the end of this section.
Line 29: Zmodem or FIRST protocol RCV option. Command line parameters
will be explained at the end of this section.
Line 30: Registration Code linked to your BBS Reg number on line 4!
All other following Lines are optional, but it's a good idea to keep
them around just in case!
Command Line Parameters for Protocol Lines
──────────────────────────────────────────
All command line parameters must specify all full pathname and file
name (unless you but them in the same directory as QWKRick).
%A Replaced by address of the com port in the format 2E8.
%B Replaced with the Locked Baud Rate of the board.
%C Replaced with the Config Path Variable. IE c:\bbs\node1\
%E Replaced with the Actual or Effective Baud Rate of the user
%I Replaced with the IRQ number of the current com port
%P Replaced with the current com port Number. IE 2 NOT com 2
%F Replaced with the BBSID File Name to download or upload.
Downloads will have the format BBSID#.QWK or BBSID.QW# and
Uploads will have the format BBSID.REP.
Using SL's replacement Zmodem
─────────────────────────────
Similar to GSZ or DSZ, but make sure to include the -C command line
option to insure that it doesn't toggle the comm support.
Upcoming Enhancements
─────────────────────
Import and Export of QWK network packets. (Maybe another project
entirely!)
Support for New Bulletin files.
Support for Hello and Goodbye Screen files.
Support for File Requesting via QWKRick.
Anything else that comes out of this beta test.
Kudo's and Accolades
────────────────────
My thanks to Frank LaRosa and Tim Rossiter of Searchlight Software,
Jack Ridgeway of ABS Software and all my great Beta Testers.
Portions of QWKRick were written with SearchLight Programmers Library.
Problems or Questions
─────────────────────
Please contact me if you have any questions, problems or suggestions.
I can be reached at the following locations:
Rick Macdougall (Me)
250:10/0 SL Net
1:167/135 Fido Net
(514) 748-5673 Rigel BBS
(514) 747-9405 Voice Phone Nights and weekends. Please Feel free to call
if any problems crop up.
Chris Ross (Alpha Site)
250:1000/1352 SL Net
(514) 466-9637 Evening Shade BBS
This is a beta test version, and as such, I ask that you do not
distribute it. This also explains the lack of real documentation... <g>
Rick Macdougall
March 8th, 1993
Copywrite 1993 JRM Enterprises